Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #1068

Closed
wants to merge 1 commit into from
Closed

Update README.md #1068

wants to merge 1 commit into from

Conversation

fzeoli
Copy link
Member

@fzeoli fzeoli commented Aug 9, 2024

Give more visibility to the Telegram group link

Give more visibility to the Telegram group link
@fzeoli fzeoli requested a review from a team as a code owner August 9, 2024 18:33
Copy link

changeset-bot bot commented Aug 9, 2024

⚠️ No Changeset found

Latest commit: 9773e27

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@OmarTawfik
Copy link
Contributor

@fzeoli there are a few formatting issues, plus more README files to update/keep in sync.
I created #1069 with the updates, and fixed the ones here.
Please let me know if you have any suggestions.

@OmarTawfik OmarTawfik closed this Aug 10, 2024
@OmarTawfik OmarTawfik deleted the fzeoli-readme-tweak branch August 10, 2024 06:39
@fzeoli
Copy link
Member Author

fzeoli commented Aug 11, 2024

Thanks! Not sure what the formatting issue is, I can't see one in my diff (and I edited using Github's online editor 😅). The quote block ("> ") I removed on purpose as it was giving the line a weaker visual hierarchy. Removing that was raising visibility a bit so it doesn't risk going unnoticed as a footer kinda thing.
The readme I mainly care about is the one that's displayed on the repo page @NomicFoundation/slang -- the other ones I don't think matter as much as this one.

@OmarTawfik
Copy link
Contributor

@fzeoli the same README message is displayed in:

  1. this repository:

image

  1. the Rust crate:

image

  1. the NPM package:

image

Perhaps it is only "less" visible in the first case? what about we use a GitHub (caution?) alert instead of a <blockquote>? it will look like this:

Caution

This project is still in alpha, and is under active development. If you are planning on using it, please reach out to us on Telegram so we can help you get started.

@fzeoli
Copy link
Member Author

fzeoli commented Aug 12, 2024

I still don't understand what the formatting issue is, but with the Telegram link having its own separate line in addition to being mentioned in the warning sentence, I think that mostly achieves my intent.

As of right now I think the changes I originally suggested work, but feel free to modify it as you see fit as long as the link to the Telegram group is prominent, easy to find, and not communicated only in the context of a long grayed out sentence about the project being in alpha.

The caution formatting does make it stand out more, but it also makes it feel more alarming, which may deter people from using Slang, rather than letting them know that they should be careful. The alpha warning isn't the main thing though. The Telegram group is.

@OmarTawfik
Copy link
Contributor

I still don't understand what the formatting issue is

The original formatting issue is here:

[warn] README.md
[warn] Code style issues found in the above file. Run Prettier with --write to fix.

Command failed with code '1' and signal 'UNKNOWN':
prettier --check .

Running that command line locally removes the trailing spaces on the last lines here.

the Telegram link having its own separate line in addition to being mentioned in the warning sentence, I think that mostly achieves my intent.

The alpha warning isn't the main thing though. The Telegram group is.

Sounds good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants